home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3x / curs_window.z / curs_window
Encoding:
Text File  |  1998-10-20  |  12.4 KB  |  194 lines
  1.  
  2.  
  3.  
  4. ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))                                                ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_uuuu_rrrr_ssss______wwww_iiii_nnnn_dddd_oooo_wwww:  _nnnn_eeee_wwww_wwww_iiii_nnnn, _dddd_eeee_llll_wwww_iiii_nnnn, _mmmm_vvvv_wwww_iiii_nnnn, _ssss_uuuu_bbbb_wwww_iiii_nnnn, _dddd_eeee_rrrr_wwww_iiii_nnnn, _mmmm_vvvv_dddd_eeee_rrrr_wwww_iiii_nnnn, _dddd_uuuu_pppp_wwww_iiii_nnnn,
  10.      _wwww_ssss_yyyy_nnnn_cccc_uuuu_pppp, _ssss_yyyy_nnnn_cccc_oooo_kkkk, _wwww_cccc_uuuu_rrrr_ssss_yyyy_nnnn_cccc_uuuu_pppp, _wwww_ssss_yyyy_nnnn_cccc_dddd_oooo_wwww_nnnn - create _cccc_uuuu_rrrr_ssss_eeee_ssss windows
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>
  14.  
  15.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_nnnn_eeee_wwww_wwww_iiii_nnnn_((((_iiii_nnnn_tttt _nnnn_llll_iiii_nnnn_eeee_ssss_,,,, _iiii_nnnn_tttt _nnnn_cccc_oooo_llll_ssss_,,,, _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______yyyy_,,,,
  16.           _iiii_nnnn_tttt_bbbb_eeee_gggg_iiii_nnnn______xxxx_))))_;;;;
  17.  
  18.      _iiii_nnnn_tttt _dddd_eeee_llll_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;;
  19.      _iiii_nnnn_tttt _mmmm_vvvv_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_))))_;;;;
  20.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_ssss_uuuu_bbbb_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_oooo_rrrr_iiii_gggg_,,,, _iiii_nnnn_tttt _nnnn_llll_iiii_nnnn_eeee_ssss_,,,, _iiii_nnnn_tttt _nnnn_cccc_oooo_llll_ssss_,,,,
  21.           _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______yyyy_,,,, _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______xxxx_))))_;;;;
  22.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_dddd_eeee_rrrr_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_oooo_rrrr_iiii_gggg_,,,, _iiii_nnnn_tttt _nnnn_llll_iiii_nnnn_eeee_ssss_,,,, _iiii_nnnn_tttt _nnnn_cccc_oooo_llll_ssss_,,,,
  23.           _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______yyyy_,,,, _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______xxxx_))))_;;;;
  24.      _iiii_nnnn_tttt _mmmm_vvvv_dddd_eeee_rrrr_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _pppp_aaaa_rrrr______yyyy_,,,, _iiii_nnnn_tttt _pppp_aaaa_rrrr______xxxx_))))_;;;;
  25.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_dddd_uuuu_pppp_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;;
  26.      _vvvv_oooo_iiii_dddd _wwww_ssss_yyyy_nnnn_cccc_uuuu_pppp_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;;
  27.      _iiii_nnnn_tttt _ssss_yyyy_nnnn_cccc_oooo_kkkk_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
  28.      _vvvv_oooo_iiii_dddd _wwww_cccc_uuuu_rrrr_ssss_yyyy_nnnn_cccc_uuuu_pppp_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;;
  29.      _vvvv_oooo_iiii_dddd _wwww_ssss_yyyy_nnnn_cccc_dddd_oooo_wwww_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;;
  30.  
  31. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  32.      The _nnnn_eeee_wwww_wwww_iiii_nnnn routine creates and returns a pointer to a new window with the
  33.      given number of lines, _n_l_i_n_e_s, and columns, _n_c_o_l_s.  The upper left-hand
  34.      corner of the window is at line _b_e_g_i_n__y, column _b_e_g_i_n__x.  If either
  35.      _n_l_i_n_e_s or _n_c_o_l_s is zero, they default to _LLLL_IIII_NNNN_EEEE_SSSS _---- _b_e_g_i_n__y and _CCCC_OOOO_LLLL_SSSS _----
  36.      _b_e_g_i_n__x.  A new full-screen window is created by calling _nnnn_eeee_wwww_wwww_iiii_nnnn_((((_0000_,,,,_0000_,,,,_0000_,,,,_0000_)))).
  37.  
  38.      The _dddd_eeee_llll_wwww_iiii_nnnn routine deletes the named window, freeing all memory
  39.      associated with it.  Subwindows must be deleted before the main window
  40.      can be deleted.
  41.  
  42.      The _mmmm_vvvv_wwww_iiii_nnnn routine moves the window so that the upper left-hand corner is
  43.      at position (_x, _y).  If the move would cause the window to be off the
  44.      screen, it is an error and the window is not moved.  Moving subwindows is
  45.      allowed, but should be avoided.
  46.  
  47.      The _ssss_uuuu_bbbb_wwww_iiii_nnnn routine creates and returns a pointer to a new window with the
  48.      given number of lines, _n_l_i_n_e_s, and columns, _n_c_o_l_s.  The window is at
  49.      position (_b_e_g_i_n__y, _b_e_g_i_n__x) on the screen.  (This position is relative to
  50.      the screen, and not to the window _o_r_i_g.)  The window is made in the
  51.      middle of the window _o_r_i_g, so that changes made to one window will affect
  52.      both windows.  The subwindow shares memory with the window _o_r_i_g.  When
  53.      using this routine, it is necessary to call _tttt_oooo_uuuu_cccc_hhhh_wwww_iiii_nnnn or _tttt_oooo_uuuu_cccc_hhhh_llll_iiii_nnnn_eeee on _o_r_i_g
  54.      before calling _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh on the subwindow.
  56.  
  57.  
  58.                                                                         PPPPaaaaggggeeee 1111
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))                                                ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))
  66.  
  67.  
  68.  
  69.      The _dddd_eeee_rrrr_wwww_iiii_nnnn routine is the same as _ssss_uuuu_bbbb_wwww_iiii_nnnn_,,,, except that _b_e_g_i_n__y and _b_e_g_i_n__x
  70.      are relative to the origin of the window _o_r_i_g rather than the screen.
  71.      There is no difference between the subwindows and the derived windows.
  72.  
  73.      The _mmmm_vvvv_dddd_eeee_rrrr_wwww_iiii_nnnn routine moves a derived window (or subwindow) inside its
  74.      parent window.  The screen-relative parameters of the window are not
  75.      changed.  This routine is used to display different parts of the parent
  76.      window at the same physical position on the screen.
  77.  
  78.      The _dddd_uuuu_pppp_wwww_iiii_nnnn routine creates an exact duplicate of the window _w_i_n.
  79.  
  80.      Each _cccc_uuuu_rrrr_ssss_eeee_ssss window maintains two data structures: the character image
  81.      structure and the status structure.  The character image structure is
  82.      shared among all windows in the window hierarchy (_i._e., the window with
  83.      all subwindows).  The status structure, which contains information about
  84.      individual line changes in the window, is private to each window.  The
  85.      routine _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh uses the status data structure when performing screen
  86.      updating.  Since status structures are not shared, changes made to one
  87.      window in the hierarchy may not be properly reflected on the screen.
  88.  
  89.      The routine _wwww_ssss_yyyy_nnnn_cccc_uuuu_pppp causes the changes in the status structure of a
  90.      window to be reflected in the status structures of its ancestors.  If
  91.      _ssss_yyyy_nnnn_cccc_oooo_kkkk is called with second argument _TTTT_RRRR_UUUU_EEEE then _wwww_ssss_yyyy_nnnn_cccc_uuuu_pppp is called
  92.      automatically whenever there is a change in the window.
  93.  
  94.      The routine _wwww_cccc_uuuu_rrrr_ssss_yyyy_nnnn_cccc_uuuu_pppp updates the current cursor position of all the
  95.      ancestors of the window to reflect the current cursor position of the
  96.      window.
  97.  
  98.      The routine _wwww_ssss_yyyy_nnnn_cccc_dddd_oooo_wwww_nnnn updates the status structure of the window to
  99.      reflect the changes in the status structures of its ancestors.
  100.      Applications seldom call this routine because it is called automatically
  101.      by _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh.
  102.  
  103. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  104.      Routines that return an integer return the integer _EEEE_RRRR_RRRR upon failure and
  105.      an integer value other than _EEEE_RRRR_RRRR upon successful completion.
  106.  
  107.      _dddd_eeee_llll_wwww_iiii_nnnn returns the integer _EEEE_RRRR_RRRR upon failure and _OOOO_KKKK upon successful
  108.      completion.
  109.  
  110.      Routines that return pointers return _NNNN_UUUU_LLLL_LLLL on error.
  111.  
  112. NNNNOOOOTTTTEEEESSSS
  113.      The header file _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> automatically includes the header files
  114.      _<<<<_ssss_tttt_dddd_iiii_oooo_...._hhhh_>>>> and _<<<<_uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh_>>>>.
  115.  
  116.      If many small changes are made to the window, the _wwww_ssss_yyyy_nnnn_cccc_uuuu_pppp option could
  117.      degrade performance.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                                                         PPPPaaaaggggeeee 2222
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131. ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))                                                ccccuuuurrrrssss____wwwwiiiinnnnddddoooowwww((((3333XXXX))))
  132.  
  133.  
  134.  
  135.      Note that _ssss_yyyy_nnnn_cccc_oooo_kkkk may be a macro.
  136.  
  137. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  138.      _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X), _cccc_uuuu_rrrr_ssss______tttt_oooo_uuuu_cccc_hhhh(3X)
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.                                                                         PPPPaaaaggggeeee 3333
  191.  
  192.  
  193.  
  194.